home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / prog / suprman.zip / READ.ME < prev   
Text File  |  1993-04-26  |  6KB  |  162 lines
  1.                             SUPERMANual version 1.00
  2.  
  3.  
  4. SUPERMANual is a program which will extract documentation out of your source
  5. code which is documented using the enclosed CLIPPER.HDR header.
  6.  
  7. It is capable of creating the entire Users Manual with Table of Contents that
  8. can be printed or edited with your word processor.
  9.  
  10. The file that is created is called MANUAL.DOC.  This file is an ASCII file which
  11. can be edited or printed.
  12.  
  13. Contents of this Zip are:
  14.  
  15. READ.ME       This ASCII file
  16. MANUAL.DOC    The Manual for example.prg created by MANUAL.EXE
  17. EXAMPLE.PRG   A sample program commented for SUPERMANual
  18. CLIPPER.HDR   The Header file that needs to be placed throughout your source
  19.               code with user instruction for that section of your program.
  20. MANUAL.EXE    The SUPERMANual Program
  21. MANUAL.DBF    Configuration File
  22.  
  23. After you use this the first time, the following files will be created:
  24.  
  25. TXT.DBF       The Manual Storage Database
  26. TXT.NTX       The Index for the TXT.DBF file
  27.  
  28. Here is what the header file looks like:
  29.  
  30. /*
  31. $SUPERMAN$
  32. $CHAPTER$
  33.  
  34. $SUBCHAPTER$
  35.  
  36. $HEADING$
  37.  
  38. $TXT$
  39.  
  40. $END$
  41. */
  42.  
  43. Here is how you would use this file.
  44.  
  45. /*
  46. $SUPERMAN$                  required
  47. $CHAPTER$                   up to 2 digits wide
  48. 2
  49. $SUBCHAPTER$                up to 3 digits wide
  50. 1
  51. $HEADING$                   up to 74 chrs wide
  52. Command Line Parameters
  53. $TXT$                       up to 80 chrs wide / Unlimited Length
  54. You can bypass the input/output file screen by using the built-in command
  55. line parameters.
  56.  
  57. Here is the usage:
  58.  
  59.     FIX Infile OutFile [enter]
  60.  
  61. $END$                       required
  62. */
  63.  
  64. Look in the example.prg for more info on how to add the .hdr info.
  65.  
  66. How to use SUPERMANual
  67. ----------------------
  68.  
  69. We will show you how to use SUPERMANual with the example.prg file that comes with this
  70. demo.
  71.  
  72. After unzipping these files into a directory, you need to configure MANUAL.EXE.
  73.  
  74. This is done by typing MANUAL /c
  75.  
  76. you will see a screen that looks similar to this:
  77.  
  78.      ╒═══════════════════════════════════════════════════════════════════╕
  79.      │                 SUPERMAN Config (c)1993 MoundSoft                 │
  80.      │                                                                   │
  81.      │          Assemble your User Manual from your Source Code          │
  82.      │                                                                   │
  83.      │       MoundSoft   348 Poplar Avenue   Moundsville, WV 26041       │
  84.      ╘═══════════════════════════════════════════════════════════════════╛
  85. ────────────────────────────────────────────────────────────────────────────────
  86. Enter the complete Program Name.
  87.   FIX Program - Version 1.0
  88. ────────────────────────────────────────────────────────────────────────────────
  89. Enter the copyright owner name.
  90.   Michael Abadjiev CIS 71563,3312
  91. ────────────────────────────────────────────────────────────────────────────────
  92. Enter up to a three line description.
  93.   FIX.EXE will search your CA/Clipper 5.x LIBS and convert them to
  94.   CA/Clipper 5.20 Libraries by replacing every occurrence of CLIPPER501 with
  95.   CLIPPER520, therefore making them work with CA/Clipper 5.20.
  96. ────────────────────────────────────────────────────────────────────────────────
  97.   Header :  The FIX Program - Version 1.0
  98.   Footer :  Copyright (c)1993 Michael Abadjiev
  99. ────────────────────────────────────────────────────────────────────────────────
  100.  
  101. After you press [enter] on the last field, your new info will be saved.
  102.  
  103. The next step is to run MANUAL on each one of your .prg files.
  104.  
  105. Since we are now just using the example.prg file, simply type:
  106.  
  107.                    MANUAL example  [enter]
  108.  
  109. This will build a database of all of your headers and text for the manual.
  110.  
  111. If you had more than one .prg file, you would run this on each one.
  112.  
  113. Here is a list of the command line parameters.
  114.  
  115. usage:  MANUAL filename        Will add the [filename].prg text to the
  116.                                current manual file.  Use this format for
  117.                                each of your .prg files for your appli-
  118.                                cation to the txt.dbf file.
  119.  
  120.                                Do not add the file extension.
  121.               ─────────────────────────────────────────────────────────
  122.         MANUAL filename /e     the /e switch will empty the txt.dbf file so
  123.                                you can start over.
  124.  
  125.                                Do not add the file extension.
  126.               ─────────────────────────────────────────────────────────
  127.         MANUAL CREATE          Will create the finished Manual that is ready
  128.                                to print or ready for your word processor.
  129.               ─────────────────────────────────────────────────────────
  130.         MANUAL /c              To configure this manual.
  131.               ─────────────────────────────────────────────────────────
  132.  
  133. After using MANUAL.EXE on each of your .prg's, it is time to write the manual to
  134. an ASCII file.  To do this, type:
  135.  
  136.                     MANUAL create
  137.  
  138. Before you know it, you will have a file called MANUAL.DOC in your directory,
  139. ready for printing or word processing.
  140.  
  141. You can test your manual by typing:
  142.  
  143.                     TYPE MANUAL.DOC > PRN  [enter]
  144.  
  145. This demo has two limitations.  The first one is that it will only create 6
  146. pages of your manual.
  147.  
  148. The second limitation is that it will not produce the table of contents.
  149.  
  150. The registered version does both plus has support for Laser Printers, Graphics
  151. Chrs, self designed page header & page footer, and more...
  152.  
  153.      ╒═══════════════════════════════════════════════════════════════════╕
  154.      │                SUPERMANual DEMO (c)1993 MoundSoft                 │
  155.      │                      Send $69 + $5 S&H to:                        │
  156.      │       MoundSoft   348 Poplar Avenue   Moundsville, WV 26041       │
  157.      │                                                                   │
  158.      │           Create your User Manual from your Source Code           │
  159.      │             The DEMO only creates the first 6 pages.              │
  160.      │                                                                   │
  161.      ╘═══════════════════════════════════════════════════════════════════╛
  162.